Night Owl 6

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / cbox13.zip / CHATBOX.DOC < prev next >

Wrap

Text File | 1991-12-20 | 54KB | 1,184 lines

------------------------------------------------------------------ | | | | | | | | | | | ChatBox Version 1.3 | | | | Split-Screen Sysop Chat - Caller Page Door | | | | | | For | | | | PCBoard Versions 14.5 & 14.5a | | | | | | Horizontal or Vertical Split-Screen Chat | | | | | | Sysop Configurable Page Sounds (Beeping, Telephone Ringing) | | | | | | Sysop may choose Flashing "Silent Page" Mode | | | | | | Uses PCBTEXT - Completely Language Compatible | | | | | | Seamless Appearance when used as a "Shelled-to" Door | | | | | | All Options Are Sysop-Configurable | | | | | | | | ChatBox Version 1.3 | | | | (C) Copyright 1991 Yandell Computer Services | | | | 12121 Little Road - Bldg. 303 - Suite 212 | | Hudson, FL 34667 | | | | DATA -- (813) 842-8099 (HST) | | | | | | December 20, 1991 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- ChatBox -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What Is ChatBox 3 1.1 What Is New in Version 1.3 (Upgrading) 3 1.2 Multi-Nodes, Networks, Multi-taskers 3 INSTALLING ChatBox ------------------ 2.0 Preliminaries 4 2.1 Configuring PCBoard Door Files 4 2.2 Setting Up Door Batch Files 5 2.3 Running CBSETUP and Creating CHATBOX.CNF 6-10 2.4 Setting Up for Sysop Initiated Chats 11 2.5 Setting Up for Multi-Language Use 12 2.6 Setting Up V.I.P. Callers (CHATBOX.VIP) 12 2.7 Setting Up Callers Who Cannot Page (CHATBOX.NOT) 12 2.8 Setting Up PCBoard for an Alternate Chat Device 12 RUN-TIME CONSIDERATIONS ----------------------- 3.0 Notes Regarding PCBTEXT Files 13 3.1 Notes Regarding the F4 Function Key 14 3.2 Notes regarding window (box) clearing 14 3.3 Notes regarding the "leave a comment" prompt 15 3.4 Notes Regarding SOUND.BAT 15 3.5 Notes Regarding Text File Displays 15 MISCELLANEOUS ------------- 4.0 Sysop Function Keys 16 4.1 Technical Notes 16 4.2 Caller Log Entries 16 4.3 ChatBox CHATLOG (ALT-L) Files 17 4.4 Error Messages 17 4.5 Where to Receive Assistance 17 4.6 Disclaimer and Warranty 17 4.7 About the Author 18 4.8 Acknowledgments 18 4.9 Revision History 18 REGISTRATION ------------ 5.0 Registering ChatBox 18 -------------------------------------------------------------------- Page 3 ChatBox Page 3 -------------------------------------------------------------------- 1.0 What is ChatBox -------------------- ChatBox is a Split-Screen chat utility designed for PCBoard. The Sysop may select the Split-Screen format for chatting. In horizontal mode, the screen is split into two halves (boxes), upper and lower. In vertical mode, the screen is split into two halves (boxes), left and right. The Sysop may initiate the chat. ChatBox will bypass its paging process and go directly into chat mode if initiated by the Sysop. Split-Screen chatting allows simultaneous typing between the Sysop and the caller. ChatBox allows the Sysop to select the type of sound made when a caller is paging. A different tone may be selected for the familiar "beep-beep", or one of several different telephone ringing sounds may be chosen. Sysops may choose to shell to their own noise making or screen flashing program to alert them a caller is paging. Printer bells may be used also. Three different paging periods may be set for each day of the week. Split-Screen chat colors may be configured by the Sysop (registered copies of ChatBox only). ChatBox uses PCBTEXT for multi-language compatibility and additional flexibility. ChatBox is completely DESQview aware. ChatBox works with non-standard com ports automatically. 1.1 What is new in version 1.3 (upgrading) ------------------------------------------- Please refer to the enclosed file FEATURES.NEW for a list of new features in ChatBox version 1.3. To upgrade from an earlier version, simply answer the questions in CBSETUP with blinking asterisks beside them and read the sections in this manual regarding those questions and new features. Please note that Split-Screen type #4 (vertical if 9600, horizontal if less) has been dropped in favor of the new wrapping capabilities for lower connect speeds. 1.2 Multi-nodes, networks, multi-taskers ----------------------------------------- ChatBox has been developed in a networked environment. All multi- node features are thoroughly tested on our own multi-node PCBoard system. Two of ChatBox's primary beta test facilities are twenty node systems. ChatBox is DESQview aware. It is automatically detected, screen and keyboard I/O are "well behaved", and time slices are given back to other applications while ChatBox is idle. -------------------------------------------------------------------- Page 4 ChatBox Page 4 -------------------------------------------------------------------- 2.0 Preliminaries ------------------ Create a directory or subdirectory where you normally place doors. Extract the entire contents of CBOX13.ZIP into this location. 2.1 Configuring PCBoard Door Files ----------------------------------- Install a door called PAGE into your DOOR.LST file using PCBSETUP. Answer the following questions as follows: USER DOOR Filename Password Sec Login SYS SYS Shell Path to DOOR Files -------- -------- --- ----- --- --- ----- ------------------ #) PAGE 10 N Y N Y (if appropriate) Note the use of PAGE as a door name, not CHATBOX, as you will most likely want to place PAGE as a command in your main menu (BRDM). A password would usually not be required for your PAGE door. A low security level is required, as you may also be using this same door when you wish to initiate a chat with the caller. ChatBox follows the security level for the "O" command in PCBoard. Callers who are below this level will not be able to use ChatBox to page the Sysop. A USERS.SYS file MUST be created. ChatBox will not run without it, as ChatBox NEVER accesses the USERS file. A DOOR.SYS file is NOT needed. If running PCBoard 14.5a, shelling is HIGHLY recommended because it greatly increases the speed at which PCBoard returns when the caller exits from ChatBox. ChatBox has been specifically designed as a "Shell" door. Setting up ChatBox as a "swapped shell" door is not recommended unless it is needed due to memory limitations. ChatBox only requires about 76K of memory so "swapping" the "shell to" door should not be required. If you have different DOOR.LST files in your conferences, you will need to configure the PAGE door in them also. It is up to the individual Sysop as to whether or not to place the PAGE command in the doors menu, or as a command on the main menu, or both. The recommended usage is to place PAGE on the main menu and not in the doors menu. -------------------------------------------------------------------- Page 5 ChatBox Page 5 -------------------------------------------------------------------- 2.2 Setting up door batch files -------------------------------- The purpose of this section is to explain the command line calling syntax for ChatBox. Please refer to the PCBoard manual for a more complete discussion on door batch file installation. If you have named the door PAGE (recommended) the following examples would be the contents of your door file named PAGE. *PREFERRED METHOD* (fast load!) ------------------------------- @echo off C:\CHATBOX\CHATBOX.EXE CHATBOX.CNF C:\PCB ---------------------- ----------- ------ | | |-> This node's home directory. | | | | | ---------> The name of the configuration | file. Enter a file NAME only. | NEVER place a location here. | -------> The executable file name. Placing its location in-line as shown results in MUCH faster response time in executing the door. The two lines above are all that is required to execute ChatBox when running as a shelled-to door in PCBoard 14.5a. If you are not running PCBoard 14.5a or you are not running ChatBox as a shelled-to door, add the call to BOARD.BAT as the third command in the door file Do NOT end your door file with BOARD.BAT if running ChatBox as a shell-to door in PCBoard 14.5a. *OLD FASHIONED METHOD* (tried and true, but slow load) ------------------------------------------------------ @echo off d: cd\chatbox CHATBOX.EXE CHATBOX.CNF C:\PCB c: ------ cd\pcb |-> This node's home directory. The above method will work fine with ChatBox. The only drawback is the slower loading time as a result of the changing of drives and directories in DOS. As with the "preferred method", only add BOARD.BAT to the end of the door file if you are NOT shelling to ChatBox in PCBoard 14.5a, or if you are running PCBoard 14.5. -------------------------------------------------------------------- Page 6 ChatBox Page 6 -------------------------------------------------------------------- 2.3 Running CBSETUP and creating CHATBOX.CNF --------------------------------------------- Enclosed with ChatBox 1.3 is a file called CBSETUP.EXE. This file allows you to easily and quickly configure ChatBox configuration files. Only one CHATBOX.CNF file is required for all nodes. Please refer to section 2.5 page 12 for information on creating CHATBOX.CNF files for multi-language use. To start CBSETUP.EXE, enter CBSETUP CHATBOX.CNF at your DOS prompt (CHATBOX.CNF would be the appropriate configuration file). Each parameter in CBSETUP is described on the following pages. * ChatBox registration number --------------------------- This is the registration number received when ChatBox is registered. Registration causes the ChatBox [ UNREGISTERED COPY ] message and the brief delay at program termination to disappear. This message is not replaced with your board name or anything else. The entire line completely disappears for a true, seamless, "looks like PCBoard" process if running as a shelled-to door in PCBoard 14.5a. Registration also allows ChatBox to use the Sysop defined colors for Split-Screen chat operations. * Default chat screen type -------------------------- You may select the initial type of Split-Screen chat mode to begin the on-line chat session in. The valid selections are: (1) Horizontal Split-Screen. The Sysop will be in the top half of the screen, the caller will be in the bottom half. (2) Vertical Split-Screen. The Sysop will be in the left hand side of the screen, the caller will be in the right hand side. (3) Regular non-split screen. Self explanatory. If it is determined that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen mode. If this occurs, the Sysop will receive a message on the local screen stating this. The Sysop should not try to force a Split-Screen chat session when this occurs, as it will probably only result in the caller's screen being filled with unreadable ANSI escape sequences. Section 2.3 continues on the next page -------------------------------------------------------------------- Page 7 ChatBox Page 7 -------------------------------------------------------------------- 2.3 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Sound made when Sysop is paged -------------------------------- You may select the type of sound ChatBox will make while paging. (1) The familiar "beep beep". (2) The familiar "beep beep, with a lower tone than #1. (3) European telephone ring. Two short rings. (4) Telephone ring. Low pitch. (5) Telephone ring. Medium pitch. (6) Telephone ring. High pitch. (7) Silent - Flashing box on the Sysop's screen. (8) Shell - Use another program or device for sounds or screens. (9) Use LPT1 (parallel printer) bell. (10) Use LPT2 (parallel printer) bell. (11) Use LPT3 (parallel printer) bell. Press F2 at this parameter to listen to the sound you have selected. If selecting #8 (shell) see page 15 section 3.4 for instructions on creating SOUND.BAT. If an LPT is selected, then becomes unavailable, ChatBox will change to sound #1. LPT use should be tested thoroughly with ChatBox with regard to off-line conditions and the printer, such as being powered off, the "on-line" switch being turned off, etc. Some printer's off- line conditions are not accurately set in some BIOS', which might cause unexpected results when ChatBox tries to access the printer. * Speed to wrap instead of scroll --------------------------------- If the caller is at or below this connect rate, ChatBox will wrap to the top of each window (box) when the box is filled with text. If the caller is above this speed, ChatBox will scroll the contents of the box up one line when the box is filled. Since scrolling separate parts of the screen may yield unfavorable results to callers with connect speeds of 300 and 1200, a setting of at least 1200 is recommended. Valid entries here are 300, 1200, 2400, & 9600. ChatBox will always wrap text to the top of a window when a caller is at 300 baud. * Name to Display for Sysop --------------------------- While in Split-Screen chat, this name is used to identify the Sysop in the status line for the Sysop's half of the screen. This name is used in the introductory "Hello, this is _____" text. This is also used if the Sysop drops to DOS in ChatBox. It will be displayed in front of appropriate "___ has exited to DOS" message. Section 2.3 continues on the next page -------------------------------------------------------------------- Page 8 ChatBox Page 8 -------------------------------------------------------------------- 2.3 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Color to use for Chat Text ---------------------------- Chat text (text the Sysop and caller type while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Chat text colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "2" when ChatBox is run. * Color to use for Box Lines ---------------------------- Box line (lines creating the chat "box" while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Box line colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Color for Sysop and Caller Name --------------------------------- The Sysop and caller names are placed in the "box" lines separating each "box". This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Name colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Color to use for Position Arrow --------------------------------- A "position arrow" is located on the left of each chat "box" to show the current line. This color is used when the caller is in color. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Position arrows are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. Section 2.3 continues on the next page -------------------------------------------------------------------- Page 9 ChatBox Page 9 -------------------------------------------------------------------- 2.3 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- Disable Window Screen Clearing ------------------------------ The Sysop and caller may clear their own "incoming" windows (the box the other person is typing in) for easier readability (horizontal split screen mode only). Entering a Y for yes in this parameter will disable this function during split-screen chat sessions. Please see page 14 section 3.2 for additional information. Disable `Leave a Comment' Prompt -------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment (just like PCBoard would). If the caller responds Yes, ChatBox will take the proper actions so that a C <ENTER> are entered at the main PCBoard prompt when PCBoard re-loads. Entering a Y for yes in this parameter will disable this function and simply return the caller to PCBoard whenever a page attempt is unsuccessful. * Reason Prompt (or NONE) -------------------------- If ChatBox is being used to page the Sysop, this optional parameter may be used to ask the caller to briefly state the reason they are paging the Sysop. If this parameter is blank, or NONE is entered, this question will be disabled in ChatBox. If the Sysop is initiating the chat, this parameter is ignored. A file name may be specified in this parameter by starting the left most position with a % followed by a file. If you specify a file, do NOT specify a location. The file must reside with CHATBOX.EXE. For example: %WHY.TXT Briefly state the reason for this chat? Section 2.3 continues on the next page -------------------------------------------------------------------- Page 10 ChatBox Page 10 -------------------------------------------------------------------- 2.3 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Unavailable Text ------------------ This text is displayed when F4 is toggled off, when the caller does not have a sufficient access level to request a chat, or when a page attempt goes unanswered. For example: The Sysop is not currently available for chat. The above is displayed to the caller and written to the CALLER log. A file name may be specified in this parameter by starting the left most position with a % followed by a file. Do NOT specify a location with the name. The file must reside with CHATBOX.EXE. For example: %NO.TXT No one is available for a chat. NO.TXT is displayed to the caller, the text is written to CALLER(x). * Hours Text ------------ This text is displayed when a caller is requesting a chat outside of the hours allowed for the particular day of the week. For example: Paging is allowed hh:mm - hh:mm. Please leave a comment. The above is displayed to the caller and written to the CALLER log. A file name may be specified in this parameter by starting the left most position with a % followed by a file. Do NOT specify a location with the name. The file must reside with CHATBOX.EXE. For example: %HOURS.TXT Page is not available at this hour. HOURS.TXT is displayed to caller, the text is written to CALLER(x). * Page Start and Stop Times --------------------------- You may enter 3 page starting and stopping times for each day of the week. Times must be entered in HH:MM format, where HH is a value of 0 through 23, and MM is a value of 0 through 59. CBSETUP performs minimal testing of the hours input here. Care should be taken to insure the times which are input are valid and in the HH:MM format. To disable paging on a particular day, simply set the page times for PERIOD 1 on that day a minute apart, such as 12:00 - 12:01, and set the start and stop times for PERIOD 2 & 3 to the same time. If there is concern about a caller being able to activate a page during this one minute time period during the day (which is highly unlikely), set this one minute period so it will occur during your daily event. For 24 hour paging, set PERIOD 1 to the same start and stop times. PERIODS 2 & 3 are ignored if the start and stop times are the same. The TAB key rotates through different PERIODS in the same day. -------------------------------------------------------------------- Page 11 ChatBox Page 11 -------------------------------------------------------------------- 2.4 Setting up for Sysop initiated chats ----------------------------------------- For the Sysop to initiate an on-line chat using ChatBox, all that needs to be done is for the Sysop to type PAGE <enter> at the PCBoard main prompt. While ChatBox is loading, you must quickly press any key on the local keyboard. When ChatBox loads and sees the keystroke waiting in the local system's keyboard buffer, it knows the Sysop is initiating the chat and immediately starts in chat mode instead of "paging" mode. For this to function properly with all callers, you must install the PAGE door in PCBoard so that all callers can access it with a low security in DOOR.LST. ChatBox will follow the security level for PCBoard's "O" command whenever a caller tries to page using ChatBox. * Sysop Initiated Chat - AUTOMATED Method #1 : Using PCBSETUP, you may define the ten SHIFT-FUNCTION keys (SHIFT-F1 through SHIFT-F10). This is an ideal and fast way for the Sysop to bring up the PAGE command on the caller. Bring up PCBSETUP and choose one of these keys, (SHIFT-F10 will probably be easiest to remember - F10 for PCBoard chat, SHIFT-F10 for ChatBox). These are located on the Options 2 page in PCBSETUP. To install the PAGE command, simply enter the following: F-Key #10 : PAGE ^M The ^M must be entered exactly as shown. Whenever you wish to chat with caller, press SHIFT-F10, then press any key while ChatBox is loading to bypass the page mode and start directly in chat mode (as described in the first paragraph above). It is not possible for the caller to bring up ChatBox using this method, as the caller is never capable of placing keystrokes in the local (host) keyboard while ChatBox is loading. * Sysop Initiated Chat - AUTOMATED Method #2 : Enclosed with CBOX13.ZIP are files called SET_F10.EXE and SET_F10.DOC. SET_F10 is a TSR designed to be installed in BOARD.BAT before calling PCBoard. It detects Sysop F10 key presses and asks if the Sysop wants to issue the PAGE command or use PCBoard's chat facility. SET_F10 is a separate program that is released with the ChatBox program. SET_F10.DOC contains all installation and operating instructions. No part of this manual (CHATBOX.DOC) other than this paragraph pertains to the SET_F10 program. -------------------------------------------------------------------- Page 12 ChatBox Page 12 -------------------------------------------------------------------- 2.5 Setting up for multi-language use -------------------------------------- ChatBox uses text from PCBTEXT or appropriate language files with the exception of the text that is used in CHATBOX.CNF. To make any text in CHATBOX.CNF language compatible, simply create a duplicate CHATBOX.CNF file except give it the appropriate EXTension. For instance with French, use the appropriate French in CHATBOX.FRE and ChatBox will automatically use CHATBOX.FRE instead of CHATBOX.CNF as the configuration file. You do not need to worry about what ChatBox is passed in the door file. If passed CHATBOX.CNF and the language is .FRE, ChatBox will look for CHATBOX.FRE before using CHATBOX.CNF. 2.6 Setting up V.I.P. callers (CHATBOX.VIP) -------------------------------------------- To create a VIP list of callers who may page at any time, create a text file called CHATBOX.VIP. It must reside in the same location as CHATBOX.EXE. To install special names into CHATBOX.VIP, simply enter the names one at a time, with each name beginning on a new line. Callers who appear in CHATBOX.VIP will be able to page the Sysop at any time regardless of page time settings. Callers who are listed in CHATBOX.VIP will NOT be able to PAGE the Sysop if the F4 page bell toggle has been turned off in PCBoard. It is assumed that if the Sysop has turned F4 off then he\she really doesn't wish to disturbed. 2.7 Setting up callers who cannot page (CHATBOX.NOT) ----------------------------------------------------- To create a list of callers who can NEVER page, regardless of page time settings, F4 page toggle, etc., create a text file called CHATBOX.NOT. It must reside in the same location as CHATBOX.EXE. To install names into CHATBOX.NOT simply enter the names one at a time, with each name beginning on a new line. 2.8 Setting up PCBoard for an alternate chat device ---------------------------------------------------- It is not necessary to disable PCBoard's "O" command in order for ChatBox to function. However, if you wish to use ChatBox exclusively then follow these simple steps. 1) Set record #128 in all PCBTEXT files to: "Please use the PAGE command for paging" 2) Use PCBSETUP to set the page times in PCBOARD.DAT to one minute apart, for example 12:00 - 12:01. Setting this one minute period so that it occurs during the system event is ideal. When a caller presses "O" in PCBoard, they will receive the "Please use the PAGE command" instruction contained in record #128 of the appropriate PCBTEXT file. -------------------------------------------------------------------- Page 13 ChatBox Page 13 -------------------------------------------------------------------- 3.0 Notes regarding PCBTEXT files ---------------------------------- ChatBox detects the language being used and uses the following text from the appropriate PCBTEXT (PCBTEXT.???) file. Rec# Default text 97 Page ends in 30 seconds. (Ctrl-K) Aborts . Notes: Self explanatory. 175 Sysop CHAT active at~ Notes: Written to caller log only. Time is added to end. 219 Sysop CHAT ended at~ Notes: Written to caller log and displayed after a chat. Time is added to end of line. 327 I'm back! Thanks for waiting~ Notes: Displayed on return from Sysop F5. Caller's first name is added to end of the line. 333 Hello, This is @OPTEXT@.~~ Notes: Displayed in Sysop's "box" when a chat begins. Chatbox will replace @OPTEXT@ with Sysop's name in CBSETUP. 409 Operator paged at~ Notes: Written to caller log only. Time is added to the end of the line, followed by the REASON the caller paged (if used). 418 Press (Enter) to continue Notes: Self explanatory. 436 ______ has exited to DOS. Please wait ... Notes: Displayed when Sysop F5'd to DOS. Sysop's name in CBSETUP is added to the beginning of the line. 571 Would you like to leave a comment to the Sysop instead Notes: Used if a page attempt is unsuccessful. ADDITIONAL NOTES: ----------------- @FIRST@ (caller's first name) may be used in any line. ChatBox replaces ~ characters with hard spaces in the same fashion PCBoard does in PCBTEXT. The text used from PCBTEXT files is simple informational text. ChatBox does not support the use of %FILENAME conventions in any of the above PCBTEXT parameters. -------------------------------------------------------------------- Page 14 ChatBox Page 14 -------------------------------------------------------------------- 3.1 Notes Regarding The F4 Function Key ---------------------------------------- ChatBox follows the F4 toggle from PCBoard. This allows the Sysop to easily toggle paging on or off at any time. The Sysop may also set the F4 toggle while in ChatBox. To determine if you have F4 toggled ON in PCBoard, look at PCBoard's call waiting screen. The very center information block will indicate whether "Page Bell is Off" or "Page Bell is On". If you are in PCBoard locally or a caller is on-line, you can determine if F4 is toggled on by the (B) on the very bottom status line. There may be a "P" or "A" in the parenthesis with the "B", (PAB), (AB), etc. depending on how other toggles are set in PCBoard. If a "B" is there, the page bell is toggled on and a caller may page the Sysop if the current time is within a specified paging period. 3.2 Notes regarding window (box) clearing ------------------------------------------ If this feature is allowed (in CBSETUP), the Sysop and caller may clear their incoming windows for easier readability while chatting. The Sysop sees this line in the center of the screen: [ Name ]---------------------[ ALT-C=Clear ^ ]---------------------- The caller sees this line in the center: [ Name ]----------------------[ ESC=Clear v ]----------------------- Note: The (^ and v) in each line above are actually up and down arrows, and not reproduced in the documentation to prevent problems while printing the documentation. The caller must press ESC and the Sysop must press ALT-C to clear the incoming window. This places the last line of text in the window at the top of the window. NOTE: Each person may only clear the incoming text from the other person. It is not practical to allow the person typing to clear the window they are typing (sending) in, as it is IMPOSSIBLE to know if the other person has read, or is keeping up with, the other person's typing! This is only available in Horizontal mode. The performance of this feature while in Vertical chat mode was not favorable enough to include it in ChatBox. -------------------------------------------------------------------- Page 15 ChatBox Page 15 -------------------------------------------------------------------- 3.3 Notes regarding the "Leave a comment instead?" prompt ---------------------------------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment. ChatBox uses record #571 from PCBTEXT for this purpose. If the caller responds Yes, ChatBox will take the proper actions so that a C <ENTER> are entered at the PCBoard prompt after ChatBox exits and PCBoard will act as though it were typed by the Caller. NOTE: Use of this feature requires that your main menu (BRDM) not be so long that it normally requires a "More" prompt to appear. If BRDM is too long, PCBoard will ask the "More" question, the C will be entered and ignored, then the <ENTER> will be used by the "More" question. This feature can be disabled with CBSETUP if it is not desired. 3.4 Notes regarding SOUND.BAT ------------------------------ SOUND.BAT is called if #8 has been selected for the type of sound to make when paging. ChatBox will shell out to SOUND.BAT every couple of seconds instead of making a selected noise. This allows the Sysop to make their own noise, screen displays, etc. Note: We have received reports that sound cards have been successfully used to create page sounds in SOUND.BAT. It should be noted that this process could have difficulties. It would not be surprising for some sound card drivers to created problems with communications programs. Test carefully and thoroughly if you plan on using a sound card to create page sounds. In all cases, keep whatever is placed in SOUND.BAT small and fast. 3.5 Notes regarding text file displays --------------------------------------- ChatBox will display text files if indicated in certain text prompts in CBSETUP. These text files support PCBoard color macros. Because ChatBox has been designed to be as small as possible for "shell to" door purposes, ANSI capabilities in these text files have been intentionally omitted. These text files also support the use of the @cls@ clear screen macro, as well as the use of @first@ for the caller's first name. Support for a multitude of @info@ macros has been intentionally omitted to keep memory consumption as low as possible for use in the "shell to" door process. If multi-languages are in use, the appropriate extension will be added to these files. If the language file exists, it will be shown to the caller. -------------------------------------------------------------------- Page 16 ChatBox Page 16 -------------------------------------------------------------------- 4.0 Sysop function keys ------------------------ ChatBox follows F3 (printer on/off), F4 (page bell on/off) and F9 (display on/off) toggles from PCBoard. If F3 is on, ChatBox will print any information sent to the caller log to the printer also. If F9 is off, ChatBox will clear the screen after an unsuccessful page attempt. The F4 key is explained in detail elsewhere in this manual. Sysops may drop to DOS using the F5 key if F5 drop to DOS is enabled in PCBSETUP for the node. 4.1 Technical notes -------------------- ChatBox has been designed to run specifically with PCBoard versions 14.5 & 14.5a. ChatBox will not run with earlier versions of PCBoard or with other brands of software. Carrier is monitored by ChatBox. Should a caller drop carrier while in ChatBox they will be returned to PCBoard, which will detect the "no carrier" status and cycle appropriately. ChatBox works with non-standard com ports ,addresses, and IRQs. COM1 is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other than 1 or 2 is used, ChatBox will use the address and IRQ information as indicated in PCBOARD.DAT for the node. ChatBox gives chat time credit while the Sysop is chatting with a caller. If it is detected that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen chat mode. A message will appear on the Sysop's screen if this occurs. ChatBox will act on ALT-X and ALT-N requests from the Sysop. ChatBox will set the appropriate flag so that PCBoard will use it after the caller logs off (as if ALT-X or ALT-N had been set in PCBoard). 4.2 Caller log entries ----------------------- ChatBox makes pertinent entries into the caller log as follows: If a REASON for paging is requested, the caller's answer is appended to the "Operator Paged at" text and written to the CALLER files. The "Hours available" text from CBSETUP is written to CALLER files if a page is attempted outside of paging times. The "Unavailable text" from CBSETUP is written to CALLER files if the caller lacks security to page, if F4 page is OFF, or if the Sysop does not answer a page attempt. Also see section 3.0 page 13 for other text which is written to CALLER files by ChatBox. -------------------------------------------------------------------- Page 17 ChatBox Page 17 -------------------------------------------------------------------- 4.3 ChatBox CHATLOG (ALT-L) files ---------------------------------- Sysops may keep a record of the contents of their chat with a caller by entering ALT-L during the chat. ChatBox will add the text of the chat to a file called CHATLOG.xxx, where xxx is the node number the chat is occurring on. CHATLOG files are located with CHATBOX.EXE. CHATLOG files are appended (added) to with each ALT-L, so care should be taken if this feature is used often so that the log files will not become too large to handle. 4.4 Error messages ------------------- ChatBox gives verbose installation error messages, such as invalid paths. These messages appear and there is a short pause while they are displayed. 4.5 Where to receive assistance -------------------------------- Yandell Computer Services (YCS) provides the following technical assistance for ChatBox: 813-842-8099 The YCS Support System. Available to all BBS Sysops. INSTANT on-line credit card registration and support system for YCS Shareware. All nodes are 14400 (HST). On-line 7 days per week, 24 hours per day. 4.5 Disclaimer and warranty ---------------------------- ChatBox is a shareware product. ChatBox may be uploaded to BBS systems as long as copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of ChatBox. Sysops who install ChatBox on their systems assume any and all liabilities for anything which may result as a consequence of running ChatBox. For registered copies of ChatBox, Yandell Computer Services warrants that ChatBox will perform as described in this documentation. In the event that ChatBox does not perform as specified, Yandell Computer Services may elect to fix ChatBox or refund the amount paid, if notified within 30 days of registration. Under no circumstances shall Yandell Computer Services or the author of ChatBox be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use ChatBox. PCBoard is a registered trademark of Clark Development Co. Inc. DESQview is a registered trademark of Quarterdeck Office Systems. -------------------------------------------------------------------- Page 18 ChatBox Page 18 -------------------------------------------------------------------- 4.7 About the author --------------------- L. Brent Yandell has been involved in telecommunications for over 5 years, and has been writing, updating, and continuously supporting BBS doors for over 4 years. Many Sysops will be familiar with PCBFV, the popular on-line PCBoard File Viewer, and QReader, the `full- screen' text door. 4.8 Acknowledgments -------------------- Appreciation and many thanks are in order for the following people: * Roy Timberman (Sound Advice) for making his twenty node system available for testing ChatBox and providing a distribution site for new releases: 816-436-4516 (HST) and 816-436-8029 (Hayes). * Jim Brewer for overall project review. * Tim Yandell for proofing this documentation. * A special thanks to all ChatBox beta testers. 4.9 Revision history --------------------- Date Version Details -------- ------- ------- 06-14-91 1.0 ChatBox initial release. 08-10-91 1.1 See the enclosed FEATURES.NEW file. 11-08-91 1.2 See the enclosed FEATURES.NEW file. 12-20-91 1.3 See the enclosed FEATURES.NEW file. 5.0 Registering ChatBox ------------------------ ChatBox is not free software. ChatBox must be registered no later than 30 days after installation. Registration removes the [UNREGISTERED COPY] message at program termination along with the corresponding brief delay. Registration also enables the use of Sysop definable colors for Split-Screen chat operations. Registration is $15.00 and may be paid by check, money order, VISA, Mastercard, or Discover. Receive a registration number INSTANTLY by registering with a major credit card! Refer to the enclosed ORDER.FRM file for complete registration instructions.